const title = `# Regan API`;
const qianyan =`
## 前言
---
*** Regan API *** 项目是基于注释自动生成api文档，很大缩短了开始与后期维护API接口文档的时间。*** Regan API *** 利用jdk提供的Doclet
类读取文档注释，可手动配置需要读取的文件，同时增加了读取过滤指定方法过滤等功能。

*** Regan API *** 基础项目基于[jfinal](http://www.jfinal.com/) 开发，前端基于[飞冰](https://alibaba.github.io/ice)开发。如果别的
项目需要引用只需要加入***src下api包下的文件，以及webapp下api目录里的页面***。

![](http://file.homeins.cn/FjnP0FvBDFwKRH4LLFwzYyI_tvbH)

![](http://file.homeins.cn/FrIAtiOVuYau1WLQ33M3w4Sqj4q5)

*** Regan API *** demo可参考：[https://gitee.com/regan_jeff/jfinal-api](https://gitee.com/regan_jeff/jfinal-api)
> 启动：执行 ApiConfig 下main方法即可。
`;
const install = `
## 入门
** 1.安装 **
* _项目框架_   项目基于jfinal框架构建。
> 可参考: [jfinal](http://www.jfinal.com/) 
* _引入依赖_
\`\`\`xml
<dependency>
  <groupId>cn.hutool</groupId>
  <artifactId>hutool-all</artifactId>
  <version>4.0.12</version>
</dependency>
<dependency>
  <groupId>com.google.guava</groupId>
  <artifactId>guava</artifactId>
  <version>18.0</version>
</dependency>
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>fastjson</artifactId>
  <version>1.2.9</version>
</dependency>
\`\`\`
* 加入 ***src下api包下的文件，以及webapp下api目录里的页面***
* jfinal 配置加入api路由
\`\`\`java
/**
 * 配置路由
 */
@Override
public void configRoute(Routes me) {
    //配置api路由
    me.add("/api", ApiController.class);
}
\`\`\`
* 启动服务访问本地地址：http://localhost:****/api

** 2.配置文件说明 **
* 在项目resources 加入 ***api.properties*** 文件，指定解析的包文件。
\`\`\`properties
#解析的controller包 多个用逗号间隔
packages=com.jfinal.api.controller

#需要过滤的controller 多个用逗号间隔
filters=UserController 

#主题色，黑：dark、白：light
theme=dark
\`\`\`

`;
const menuList = `
## 功能菜单配置 ##
### ***Controller注释配置*** ###
** 1.描述 **
`;
const controllerMenuInfo=`
** 2.样例 **
\`\`\`java
/**
 * 用户管理
 * @action /user
 * @author zhangby
 * @date 2018/6/12 下午3:26
 */
public class UserController extends Controller{
    
}
\`\`\`
`;
const methodData =`
### ***Method注释配置*** ###
** 1.描述 **
`;
const methodDataInfo=`
** 2.样例 **

\`\`\`java
    /**
     * 用户登录功
     * @title 登录接口
     * @param username|用户名|string|必填
     * @param password|密码|string|必填
     * @resqParam code|用户名|String|必填
     * @resqParam data|数据|object|非必填
     * @resqParam msg|消息信息|String|必填
     * @respBody {"code":"000","data":"","msg":"success"}
     * @author zhangby
     * @date 2018/6/12 下午4:23
     */
    public void login() {
        renderJson(Kv.create().set("code","000"));
    }
\`\`\`

> 注：如果需要过滤controller中的方法，可在方法上添加 ***@ApiIgnore***注解。
`;
const postman = `
## postman ##

*** Regan API ***提供了简单的后台接口调用与测试功能。默认每个接口都会自动生成对应的接口调用地址，与参数配置可直接测试接口返回数据。

![](http://file.homeins.cn/Fj20i2XJxnvS1dRn4MBTn-Xn5An8)

*** Regan API ***对于复杂的接口参数请求如果满足不了的话，可切换至json请求数据面板。

![](http://file.homeins.cn/FheAN8O6rG_5cTDFmeeE1LqoK9_y)
`;
//markDown 文件
export const markDownJson = {
    "title":title,
    "qianyan":qianyan,
    "install":install,
    "menuList":menuList,
    "controllerMenuInfo":controllerMenuInfo,
    "methodData":methodData,
    "methodDataInfo":methodDataInfo,
    "postman":postman,
};